<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <title>SFML - Simple and Fast Multimedia Library</title>
        <meta http-equiv="Content-Type" content="text/html;"/>
        <meta charset="utf-8"/>
        <!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
        <link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
        <script type="text/javascript" src="jquery.js"></script>
        <script type="text/javascript" src="dynsections.js"></script>
        <link rel="stylesheet" type="text/css" href="search/search.css" />
        <link rel="stylesheet" type="text/css" href="searchOverrides.css" />
        <script type="text/javascript" src="search/searchdata.js"></script>
        <script type="text/javascript" src="search/search.js"></script>
        <script type="text/javascript">
        /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
          $(document).ready(function() { init_search(); });
        /* @license-end */
        </script>
    </head>
    <body>
        <div id="banner-container">
            <div id="banner">
                <span id="sfml">SFML 2.6.1</span>
            </div>
        </div>
        <div id="content">
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>sf</b></li><li class="navelem"><a class="el" href="classsf_1_1String.html">String</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="#related">Related Symbols</a> &#124;
<a href="classsf_1_1String-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">sf::String Class Reference<div class="ingroups"><a class="el" href="group__system.html">System module</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Utility string class that automatically handles conversions between types and encodings.  
 <a href="classsf_1_1String.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="String_8hpp_source.html">SFML/System/String.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac90f2b7b28f703020f8d027e98806235"><td class="memItemLeft" align="right" valign="top">typedef std::basic_string&lt; Uint32 &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ac90f2b7b28f703020f8d027e98806235">Iterator</a></td></tr>
<tr class="memdesc:ac90f2b7b28f703020f8d027e98806235"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator type.  <br /></td></tr>
<tr class="separator:ac90f2b7b28f703020f8d027e98806235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e18efc2e8464f6eb82818902d527efa"><td class="memItemLeft" align="right" valign="top">typedef std::basic_string&lt; Uint32 &gt;::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a></td></tr>
<tr class="memdesc:a8e18efc2e8464f6eb82818902d527efa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read-only iterator type.  <br /></td></tr>
<tr class="separator:a8e18efc2e8464f6eb82818902d527efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9563a4e93f692e0c8e8702b374ef8692"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a9563a4e93f692e0c8e8702b374ef8692">String</a> ()</td></tr>
<tr class="memdesc:a9563a4e93f692e0c8e8702b374ef8692"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <br /></td></tr>
<tr class="separator:a9563a4e93f692e0c8e8702b374ef8692"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9df7f7696cff164794e338f3c89ccc5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ac9df7f7696cff164794e338f3c89ccc5">String</a> (char ansiChar, const std::locale &amp;locale=std::locale())</td></tr>
<tr class="memdesc:ac9df7f7696cff164794e338f3c89ccc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from a single ANSI character and a locale.  <br /></td></tr>
<tr class="separator:ac9df7f7696cff164794e338f3c89ccc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefaa202d2aa5ff85b4f75a5983367e86"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#aefaa202d2aa5ff85b4f75a5983367e86">String</a> (wchar_t wideChar)</td></tr>
<tr class="memdesc:aefaa202d2aa5ff85b4f75a5983367e86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from single wide character.  <br /></td></tr>
<tr class="separator:aefaa202d2aa5ff85b4f75a5983367e86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e1a5027416d121187908e2ed77079ff"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a8e1a5027416d121187908e2ed77079ff">String</a> (Uint32 utf32Char)</td></tr>
<tr class="memdesc:a8e1a5027416d121187908e2ed77079ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from single UTF-32 character.  <br /></td></tr>
<tr class="separator:a8e1a5027416d121187908e2ed77079ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57d2b8c289f9894f859564cad034bfc7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a57d2b8c289f9894f859564cad034bfc7">String</a> (const char *ansiString, const std::locale &amp;locale=std::locale())</td></tr>
<tr class="memdesc:a57d2b8c289f9894f859564cad034bfc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from a null-terminated C-style ANSI string and a locale.  <br /></td></tr>
<tr class="separator:a57d2b8c289f9894f859564cad034bfc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0aa41dcbd17b0c36c74d03d3b0147f1e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a0aa41dcbd17b0c36c74d03d3b0147f1e">String</a> (const std::string &amp;ansiString, const std::locale &amp;locale=std::locale())</td></tr>
<tr class="memdesc:a0aa41dcbd17b0c36c74d03d3b0147f1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from an ANSI string and a locale.  <br /></td></tr>
<tr class="separator:a0aa41dcbd17b0c36c74d03d3b0147f1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5742d0a9b0c754f711820c2b5c40fa55"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a5742d0a9b0c754f711820c2b5c40fa55">String</a> (const wchar_t *wideString)</td></tr>
<tr class="memdesc:a5742d0a9b0c754f711820c2b5c40fa55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from null-terminated C-style wide string.  <br /></td></tr>
<tr class="separator:a5742d0a9b0c754f711820c2b5c40fa55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e38151340af4f9a5f74ad24c0664074"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a5e38151340af4f9a5f74ad24c0664074">String</a> (const std::wstring &amp;wideString)</td></tr>
<tr class="memdesc:a5e38151340af4f9a5f74ad24c0664074"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from a wide string.  <br /></td></tr>
<tr class="separator:a5e38151340af4f9a5f74ad24c0664074"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea3629adf19f9fe713d4946f6c75b214"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#aea3629adf19f9fe713d4946f6c75b214">String</a> (const Uint32 *utf32String)</td></tr>
<tr class="memdesc:aea3629adf19f9fe713d4946f6c75b214"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from a null-terminated C-style UTF-32 string.  <br /></td></tr>
<tr class="separator:aea3629adf19f9fe713d4946f6c75b214"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6eee86dbe75d16bbcc26e97416c2e1ca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a6eee86dbe75d16bbcc26e97416c2e1ca">String</a> (const std::basic_string&lt; Uint32 &gt; &amp;utf32String)</td></tr>
<tr class="memdesc:a6eee86dbe75d16bbcc26e97416c2e1ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from an UTF-32 string.  <br /></td></tr>
<tr class="separator:a6eee86dbe75d16bbcc26e97416c2e1ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af862594d3c4070d8ddbf08cf8dce4f59"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#af862594d3c4070d8ddbf08cf8dce4f59">String</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;copy)</td></tr>
<tr class="memdesc:af862594d3c4070d8ddbf08cf8dce4f59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <br /></td></tr>
<tr class="separator:af862594d3c4070d8ddbf08cf8dce4f59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a884816a0f688cfd48f9324c9741dc257"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a884816a0f688cfd48f9324c9741dc257">operator std::string</a> () const</td></tr>
<tr class="memdesc:a884816a0f688cfd48f9324c9741dc257"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator to std::string (ANSI string)  <br /></td></tr>
<tr class="separator:a884816a0f688cfd48f9324c9741dc257"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bd1444bebaca9bbf01ba203061f5076"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a6bd1444bebaca9bbf01ba203061f5076">operator std::wstring</a> () const</td></tr>
<tr class="memdesc:a6bd1444bebaca9bbf01ba203061f5076"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator to std::wstring (wide string)  <br /></td></tr>
<tr class="separator:a6bd1444bebaca9bbf01ba203061f5076"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada5d5bba4528aceb0a1e298553e6c30a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ada5d5bba4528aceb0a1e298553e6c30a">toAnsiString</a> (const std::locale &amp;locale=std::locale()) const</td></tr>
<tr class="memdesc:ada5d5bba4528aceb0a1e298553e6c30a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert the Unicode string to an ANSI string.  <br /></td></tr>
<tr class="separator:ada5d5bba4528aceb0a1e298553e6c30a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d81aa3103e7e2062bd85d912a5aecf1"><td class="memItemLeft" align="right" valign="top">std::wstring&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a9d81aa3103e7e2062bd85d912a5aecf1">toWideString</a> () const</td></tr>
<tr class="memdesc:a9d81aa3103e7e2062bd85d912a5aecf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert the Unicode string to a wide string.  <br /></td></tr>
<tr class="separator:a9d81aa3103e7e2062bd85d912a5aecf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a4f366d5db833ae818881507b46e13a"><td class="memItemLeft" align="right" valign="top">std::basic_string&lt; Uint8 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a2a4f366d5db833ae818881507b46e13a">toUtf8</a> () const</td></tr>
<tr class="memdesc:a2a4f366d5db833ae818881507b46e13a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert the Unicode string to a UTF-8 string.  <br /></td></tr>
<tr class="separator:a2a4f366d5db833ae818881507b46e13a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab805f230a0b2e972f9f32ac4cf11d912"><td class="memItemLeft" align="right" valign="top">std::basic_string&lt; Uint16 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ab805f230a0b2e972f9f32ac4cf11d912">toUtf16</a> () const</td></tr>
<tr class="memdesc:ab805f230a0b2e972f9f32ac4cf11d912"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert the Unicode string to a UTF-16 string.  <br /></td></tr>
<tr class="separator:ab805f230a0b2e972f9f32ac4cf11d912"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef4f51ebe43465c665c78692d0262e43"><td class="memItemLeft" align="right" valign="top">std::basic_string&lt; Uint32 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#aef4f51ebe43465c665c78692d0262e43">toUtf32</a> () const</td></tr>
<tr class="memdesc:aef4f51ebe43465c665c78692d0262e43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert the Unicode string to a UTF-32 string.  <br /></td></tr>
<tr class="separator:aef4f51ebe43465c665c78692d0262e43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af14c8e1bf351cf18486f0258c36260d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#af14c8e1bf351cf18486f0258c36260d7">operator=</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="memdesc:af14c8e1bf351cf18486f0258c36260d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of assignment operator.  <br /></td></tr>
<tr class="separator:af14c8e1bf351cf18486f0258c36260d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdae61e813b2951a6e39015e34a143f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#afdae61e813b2951a6e39015e34a143f7">operator+=</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="memdesc:afdae61e813b2951a6e39015e34a143f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of += operator to append an UTF-32 string.  <br /></td></tr>
<tr class="separator:afdae61e813b2951a6e39015e34a143f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a035c1b585a0ebed81e773ecafed57926"><td class="memItemLeft" align="right" valign="top">Uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a035c1b585a0ebed81e773ecafed57926">operator[]</a> (std::size_t index) const</td></tr>
<tr class="memdesc:a035c1b585a0ebed81e773ecafed57926"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of [] operator to access a character by its position.  <br /></td></tr>
<tr class="separator:a035c1b585a0ebed81e773ecafed57926"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e2041bd9ae84d223e6b12e46e5aa5d6"><td class="memItemLeft" align="right" valign="top">Uint32 &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a3e2041bd9ae84d223e6b12e46e5aa5d6">operator[]</a> (std::size_t index)</td></tr>
<tr class="memdesc:a3e2041bd9ae84d223e6b12e46e5aa5d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of [] operator to access a character by its position.  <br /></td></tr>
<tr class="separator:a3e2041bd9ae84d223e6b12e46e5aa5d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a391c1b4950cbf3d3f8040cea73af2969"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a391c1b4950cbf3d3f8040cea73af2969">clear</a> ()</td></tr>
<tr class="memdesc:a391c1b4950cbf3d3f8040cea73af2969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the string.  <br /></td></tr>
<tr class="separator:a391c1b4950cbf3d3f8040cea73af2969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7aff54e178f5d3e399953adff5cad20"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ae7aff54e178f5d3e399953adff5cad20">getSize</a> () const</td></tr>
<tr class="memdesc:ae7aff54e178f5d3e399953adff5cad20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the size of the string.  <br /></td></tr>
<tr class="separator:ae7aff54e178f5d3e399953adff5cad20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ba26cb6945d2bbb210b822f222aa7f6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a2ba26cb6945d2bbb210b822f222aa7f6">isEmpty</a> () const</td></tr>
<tr class="memdesc:a2ba26cb6945d2bbb210b822f222aa7f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether the string is empty or not.  <br /></td></tr>
<tr class="separator:a2ba26cb6945d2bbb210b822f222aa7f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa78a0a46b3fbe200a4ccdedc326eb93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#aaa78a0a46b3fbe200a4ccdedc326eb93">erase</a> (std::size_t position, std::size_t count=1)</td></tr>
<tr class="memdesc:aaa78a0a46b3fbe200a4ccdedc326eb93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erase one or more characters from the string.  <br /></td></tr>
<tr class="separator:aaa78a0a46b3fbe200a4ccdedc326eb93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0b1455deabf07af13ee79812e05fa02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ad0b1455deabf07af13ee79812e05fa02">insert</a> (std::size_t position, const <a class="el" href="classsf_1_1String.html">String</a> &amp;str)</td></tr>
<tr class="memdesc:ad0b1455deabf07af13ee79812e05fa02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert one or more characters into the string.  <br /></td></tr>
<tr class="separator:ad0b1455deabf07af13ee79812e05fa02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa189ec8656854106ab8d2e935fd9cbcc"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#aa189ec8656854106ab8d2e935fd9cbcc">find</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;str, std::size_t start=0) const</td></tr>
<tr class="memdesc:aa189ec8656854106ab8d2e935fd9cbcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a sequence of one or more characters in the string.  <br /></td></tr>
<tr class="separator:aa189ec8656854106ab8d2e935fd9cbcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad460e628c287b0fa88deba2eb0b6744b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ad460e628c287b0fa88deba2eb0b6744b">replace</a> (std::size_t position, std::size_t length, const <a class="el" href="classsf_1_1String.html">String</a> &amp;replaceWith)</td></tr>
<tr class="memdesc:ad460e628c287b0fa88deba2eb0b6744b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace a substring with another string.  <br /></td></tr>
<tr class="separator:ad460e628c287b0fa88deba2eb0b6744b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82bbfee2bf23c641e5361ad505c07921"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a82bbfee2bf23c641e5361ad505c07921">replace</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;searchFor, const <a class="el" href="classsf_1_1String.html">String</a> &amp;replaceWith)</td></tr>
<tr class="memdesc:a82bbfee2bf23c641e5361ad505c07921"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace all occurrences of a substring with a replacement string.  <br /></td></tr>
<tr class="separator:a82bbfee2bf23c641e5361ad505c07921"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a492645e00032455e6d92ff0e992654ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a492645e00032455e6d92ff0e992654ce">substring</a> (std::size_t position, std::size_t length=<a class="el" href="classsf_1_1String.html#abaadecaf12a6b41c54d725c75fd28527">InvalidPos</a>) const</td></tr>
<tr class="memdesc:a492645e00032455e6d92ff0e992654ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a part of the string.  <br /></td></tr>
<tr class="separator:a492645e00032455e6d92ff0e992654ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ed7f3ad41659a2b31a8d8e99a7b8199"><td class="memItemLeft" align="right" valign="top">const Uint32 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a3ed7f3ad41659a2b31a8d8e99a7b8199">getData</a> () const</td></tr>
<tr class="memdesc:a3ed7f3ad41659a2b31a8d8e99a7b8199"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pointer to the C-style array of characters.  <br /></td></tr>
<tr class="separator:a3ed7f3ad41659a2b31a8d8e99a7b8199"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ec30ddc08e3a6bd11c99aed782f6dfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html#ac90f2b7b28f703020f8d027e98806235">Iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a8ec30ddc08e3a6bd11c99aed782f6dfe">begin</a> ()</td></tr>
<tr class="memdesc:a8ec30ddc08e3a6bd11c99aed782f6dfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an iterator to the beginning of the string.  <br /></td></tr>
<tr class="separator:a8ec30ddc08e3a6bd11c99aed782f6dfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e4755d6b4d51de7c3dc2e984b79f95d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a0e4755d6b4d51de7c3dc2e984b79f95d">begin</a> () const</td></tr>
<tr class="memdesc:a0e4755d6b4d51de7c3dc2e984b79f95d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an iterator to the beginning of the string.  <br /></td></tr>
<tr class="separator:a0e4755d6b4d51de7c3dc2e984b79f95d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac823012f39cb6f61100418876e99d53b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html#ac90f2b7b28f703020f8d027e98806235">Iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ac823012f39cb6f61100418876e99d53b">end</a> ()</td></tr>
<tr class="memdesc:ac823012f39cb6f61100418876e99d53b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an iterator to the end of the string.  <br /></td></tr>
<tr class="separator:ac823012f39cb6f61100418876e99d53b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1ab4c82ff2bdfb6903b4b1bb78a8e5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#af1ab4c82ff2bdfb6903b4b1bb78a8e5c">end</a> () const</td></tr>
<tr class="memdesc:af1ab4c82ff2bdfb6903b4b1bb78a8e5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an iterator to the end of the string.  <br /></td></tr>
<tr class="separator:af1ab4c82ff2bdfb6903b4b1bb78a8e5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa7beb7ae5b26e63dcbbfa390e27a9e4b"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:aa7beb7ae5b26e63dcbbfa390e27a9e4b"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1String.html">String</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#aa7beb7ae5b26e63dcbbfa390e27a9e4b">fromUtf8</a> (T <a class="el" href="classsf_1_1String.html#a8ec30ddc08e3a6bd11c99aed782f6dfe">begin</a>, T <a class="el" href="classsf_1_1String.html#ac823012f39cb6f61100418876e99d53b">end</a>)</td></tr>
<tr class="memdesc:aa7beb7ae5b26e63dcbbfa390e27a9e4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> from a UTF-8 encoded string.  <br /></td></tr>
<tr class="separator:aa7beb7ae5b26e63dcbbfa390e27a9e4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81f70eecad0000a4f2e4d66f97b80300"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a81f70eecad0000a4f2e4d66f97b80300"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1String.html">String</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a81f70eecad0000a4f2e4d66f97b80300">fromUtf16</a> (T <a class="el" href="classsf_1_1String.html#a8ec30ddc08e3a6bd11c99aed782f6dfe">begin</a>, T <a class="el" href="classsf_1_1String.html#ac823012f39cb6f61100418876e99d53b">end</a>)</td></tr>
<tr class="memdesc:a81f70eecad0000a4f2e4d66f97b80300"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> from a UTF-16 encoded string.  <br /></td></tr>
<tr class="separator:a81f70eecad0000a4f2e4d66f97b80300"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab023a4900dce37ee71ab9e29b30a23cb"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ab023a4900dce37ee71ab9e29b30a23cb"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1String.html">String</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ab023a4900dce37ee71ab9e29b30a23cb">fromUtf32</a> (T <a class="el" href="classsf_1_1String.html#a8ec30ddc08e3a6bd11c99aed782f6dfe">begin</a>, T <a class="el" href="classsf_1_1String.html#ac823012f39cb6f61100418876e99d53b">end</a>)</td></tr>
<tr class="memdesc:ab023a4900dce37ee71ab9e29b30a23cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> from a UTF-32 encoded string.  <br /></td></tr>
<tr class="separator:ab023a4900dce37ee71ab9e29b30a23cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:abaadecaf12a6b41c54d725c75fd28527"><td class="memItemLeft" align="right" valign="top">static const std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#abaadecaf12a6b41c54d725c75fd28527">InvalidPos</a></td></tr>
<tr class="memdesc:abaadecaf12a6b41c54d725c75fd28527"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an invalid position in the string.  <br /></td></tr>
<tr class="separator:abaadecaf12a6b41c54d725c75fd28527"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a483931724196c580552b68751fb4d837"><td class="memItemLeft" align="right" valign="top"><a id="a483931724196c580552b68751fb4d837" name="a483931724196c580552b68751fb4d837"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;left, const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="separator:a483931724196c580552b68751fb4d837"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5158a142e0966685ec7fb4e147b24ef0"><td class="memItemLeft" align="right" valign="top"><a id="a5158a142e0966685ec7fb4e147b24ef0" name="a5158a142e0966685ec7fb4e147b24ef0"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;</b> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;left, const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="separator:a5158a142e0966685ec7fb4e147b24ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="related" name="related"></a>
Related Symbols</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member symbols.) </p>
</td></tr>
<tr class="memitem:a483931724196c580552b68751fb4d837"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a483931724196c580552b68751fb4d837">operator==</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;left, const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="memdesc:a483931724196c580552b68751fb4d837"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of == operator to compare two UTF-32 strings.  <br /></td></tr>
<tr class="separator:a483931724196c580552b68751fb4d837"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bfb9217788a9978499b8d5696bb0ef2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a3bfb9217788a9978499b8d5696bb0ef2">operator!=</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;left, const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="memdesc:a3bfb9217788a9978499b8d5696bb0ef2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of != operator to compare two UTF-32 strings.  <br /></td></tr>
<tr class="separator:a3bfb9217788a9978499b8d5696bb0ef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5158a142e0966685ec7fb4e147b24ef0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a5158a142e0966685ec7fb4e147b24ef0">operator&lt;</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;left, const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="memdesc:a5158a142e0966685ec7fb4e147b24ef0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of &lt; operator to compare two UTF-32 strings.  <br /></td></tr>
<tr class="separator:a5158a142e0966685ec7fb4e147b24ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac96278a8cbe282632b11f0c8c007df0c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ac96278a8cbe282632b11f0c8c007df0c">operator&gt;</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;left, const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="memdesc:ac96278a8cbe282632b11f0c8c007df0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of &gt; operator to compare two UTF-32 strings.  <br /></td></tr>
<tr class="separator:ac96278a8cbe282632b11f0c8c007df0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#ac1c1bb5dcf02aad3b2c0a1bf74a11cc9">operator&lt;=</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;left, const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="memdesc:ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of &lt;= operator to compare two UTF-32 strings.  <br /></td></tr>
<tr class="separator:ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a112689eec28e0ca9489e8c4ec6a34493"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#a112689eec28e0ca9489e8c4ec6a34493">operator&gt;=</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;left, const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="memdesc:a112689eec28e0ca9489e8c4ec6a34493"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of &gt;= operator to compare two UTF-32 strings.  <br /></td></tr>
<tr class="separator:a112689eec28e0ca9489e8c4ec6a34493"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af140f992b7698cf1448677c2c8e11bf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html#af140f992b7698cf1448677c2c8e11bf1">operator+</a> (const <a class="el" href="classsf_1_1String.html">String</a> &amp;left, const <a class="el" href="classsf_1_1String.html">String</a> &amp;right)</td></tr>
<tr class="memdesc:af140f992b7698cf1448677c2c8e11bf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of binary + operator to concatenate two strings.  <br /></td></tr>
<tr class="separator:af140f992b7698cf1448677c2c8e11bf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility string class that automatically handles conversions between types and encodings. </p>
<p><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> is a utility string class defined mainly for convenience.</p>
<p>It is a Unicode string (implemented using UTF-32), thus it can store any character in the world (European, Chinese, Arabic, Hebrew, etc.).</p>
<p>It automatically handles conversions from/to ANSI and wide strings, so that you can work with standard string classes and still be compatible with functions taking a <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a>.</p>
<div class="fragment"><div class="line"><a class="code hl_class" href="classsf_1_1String.html">sf::String</a> s;</div>
<div class="line"> </div>
<div class="line">std::string s1 = s;  <span class="comment">// automatically converted to ANSI string</span></div>
<div class="line">std::wstring s2 = s; <span class="comment">// automatically converted to wide string</span></div>
<div class="line">s = <span class="stringliteral">&quot;hello&quot;</span>;         <span class="comment">// automatically converted from ANSI string</span></div>
<div class="line">s = L<span class="stringliteral">&quot;hello&quot;</span>;        <span class="comment">// automatically converted from wide string</span></div>
<div class="line">s += <span class="charliteral">&#39;a&#39;</span>;            <span class="comment">// automatically converted from ANSI string</span></div>
<div class="line">s += L<span class="charliteral">&#39;a&#39;</span>;           <span class="comment">// automatically converted from wide string</span></div>
<div class="ttc" id="aclasssf_1_1String_html"><div class="ttname"><a href="classsf_1_1String.html">sf::String</a></div><div class="ttdoc">Utility string class that automatically handles conversions between types and encodings.</div><div class="ttdef"><b>Definition</b> <a href="String_8hpp_source.html#l00045">String.hpp:46</a></div></div>
</div><!-- fragment --><p>Conversions involving ANSI strings use the default user locale. However it is possible to use a custom locale if necessary: </p><div class="fragment"><div class="line">std::locale locale;</div>
<div class="line"><a class="code hl_class" href="classsf_1_1String.html">sf::String</a> s;</div>
<div class="line">...</div>
<div class="line">std::string s1 = s.<a class="code hl_function" href="classsf_1_1String.html#ada5d5bba4528aceb0a1e298553e6c30a">toAnsiString</a>(locale);</div>
<div class="line">s = <a class="code hl_class" href="classsf_1_1String.html">sf::String</a>(<span class="stringliteral">&quot;hello&quot;</span>, locale);</div>
<div class="ttc" id="aclasssf_1_1String_html_ada5d5bba4528aceb0a1e298553e6c30a"><div class="ttname"><a href="classsf_1_1String.html#ada5d5bba4528aceb0a1e298553e6c30a">sf::String::toAnsiString</a></div><div class="ttdeci">std::string toAnsiString(const std::locale &amp;locale=std::locale()) const</div><div class="ttdoc">Convert the Unicode string to an ANSI string.</div></div>
</div><!-- fragment --><p><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> defines the most important functions of the standard std::string class: removing, random access, iterating, appending, comparing, etc. However it is a simple class provided for convenience, and you may have to consider using a more optimized class if your program requires complex string handling. The automatic conversion functions will then take care of converting your string to <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> whenever SFML requires it.</p>
<p>Please note that SFML also defines a low-level, generic interface for Unicode handling, see the <a class="el" href="classsf_1_1Utf.html" title="Utility class providing generic functions for UTF conversions.">sf::Utf</a> classes. </p>

<p class="definition">Definition at line <a class="el" href="String_8hpp_source.html#l00045">45</a> of file <a class="el" href="String_8hpp_source.html">String.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a8e18efc2e8464f6eb82818902d527efa" name="a8e18efc2e8464f6eb82818902d527efa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e18efc2e8464f6eb82818902d527efa">&#9670;&#160;</a></span>ConstIterator</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::basic_string&lt;Uint32&gt;::const_iterator <a class="el" href="classsf_1_1String.html#a8e18efc2e8464f6eb82818902d527efa">sf::String::ConstIterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read-only iterator type. </p>

<p class="definition">Definition at line <a class="el" href="String_8hpp_source.html#l00053">53</a> of file <a class="el" href="String_8hpp_source.html">String.hpp</a>.</p>

</div>
</div>
<a id="ac90f2b7b28f703020f8d027e98806235" name="ac90f2b7b28f703020f8d027e98806235"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac90f2b7b28f703020f8d027e98806235">&#9670;&#160;</a></span>Iterator</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::basic_string&lt;Uint32&gt;::iterator <a class="el" href="classsf_1_1String.html#ac90f2b7b28f703020f8d027e98806235">sf::String::Iterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Iterator type. </p>

<p class="definition">Definition at line <a class="el" href="String_8hpp_source.html#l00052">52</a> of file <a class="el" href="String_8hpp_source.html">String.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9563a4e93f692e0c8e8702b374ef8692" name="a9563a4e93f692e0c8e8702b374ef8692"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9563a4e93f692e0c8e8702b374ef8692">&#9670;&#160;</a></span>String() <span class="overload">[1/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default constructor. </p>
<p>This constructor creates an empty string. </p>

</div>
</div>
<a id="ac9df7f7696cff164794e338f3c89ccc5" name="ac9df7f7696cff164794e338f3c89ccc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9df7f7696cff164794e338f3c89ccc5">&#9670;&#160;</a></span>String() <span class="overload">[2/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname"><em>ansiChar</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::locale &amp;&#160;</td>
          <td class="paramname"><em>locale</em> = <code>std::locale()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct from a single ANSI character and a locale. </p>
<p>The source character is converted to UTF-32 according to the given locale.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ansiChar</td><td>ANSI character to convert </td></tr>
    <tr><td class="paramname">locale</td><td>Locale to use for conversion </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aefaa202d2aa5ff85b4f75a5983367e86" name="aefaa202d2aa5ff85b4f75a5983367e86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefaa202d2aa5ff85b4f75a5983367e86">&#9670;&#160;</a></span>String() <span class="overload">[3/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">wchar_t&#160;</td>
          <td class="paramname"><em>wideChar</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct from single wide character. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wideChar</td><td>Wide character to convert </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a8e1a5027416d121187908e2ed77079ff" name="a8e1a5027416d121187908e2ed77079ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e1a5027416d121187908e2ed77079ff">&#9670;&#160;</a></span>String() <span class="overload">[4/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">Uint32&#160;</td>
          <td class="paramname"><em>utf32Char</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct from single UTF-32 character. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">utf32Char</td><td>UTF-32 character to convert </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a57d2b8c289f9894f859564cad034bfc7" name="a57d2b8c289f9894f859564cad034bfc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57d2b8c289f9894f859564cad034bfc7">&#9670;&#160;</a></span>String() <span class="overload">[5/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ansiString</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::locale &amp;&#160;</td>
          <td class="paramname"><em>locale</em> = <code>std::locale()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct from a null-terminated C-style ANSI string and a locale. </p>
<p>The source string is converted to UTF-32 according to the given locale.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ansiString</td><td>ANSI string to convert </td></tr>
    <tr><td class="paramname">locale</td><td>Locale to use for conversion </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a0aa41dcbd17b0c36c74d03d3b0147f1e" name="a0aa41dcbd17b0c36c74d03d3b0147f1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0aa41dcbd17b0c36c74d03d3b0147f1e">&#9670;&#160;</a></span>String() <span class="overload">[6/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>ansiString</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::locale &amp;&#160;</td>
          <td class="paramname"><em>locale</em> = <code>std::locale()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct from an ANSI string and a locale. </p>
<p>The source string is converted to UTF-32 according to the given locale.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ansiString</td><td>ANSI string to convert </td></tr>
    <tr><td class="paramname">locale</td><td>Locale to use for conversion </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a5742d0a9b0c754f711820c2b5c40fa55" name="a5742d0a9b0c754f711820c2b5c40fa55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5742d0a9b0c754f711820c2b5c40fa55">&#9670;&#160;</a></span>String() <span class="overload">[7/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const wchar_t *&#160;</td>
          <td class="paramname"><em>wideString</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct from null-terminated C-style wide string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wideString</td><td>Wide string to convert </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a5e38151340af4f9a5f74ad24c0664074" name="a5e38151340af4f9a5f74ad24c0664074"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e38151340af4f9a5f74ad24c0664074">&#9670;&#160;</a></span>String() <span class="overload">[8/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const std::wstring &amp;&#160;</td>
          <td class="paramname"><em>wideString</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct from a wide string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wideString</td><td>Wide string to convert </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aea3629adf19f9fe713d4946f6c75b214" name="aea3629adf19f9fe713d4946f6c75b214"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea3629adf19f9fe713d4946f6c75b214">&#9670;&#160;</a></span>String() <span class="overload">[9/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const Uint32 *&#160;</td>
          <td class="paramname"><em>utf32String</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct from a null-terminated C-style UTF-32 string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">utf32String</td><td>UTF-32 string to assign </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a6eee86dbe75d16bbcc26e97416c2e1ca" name="a6eee86dbe75d16bbcc26e97416c2e1ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6eee86dbe75d16bbcc26e97416c2e1ca">&#9670;&#160;</a></span>String() <span class="overload">[10/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const std::basic_string&lt; Uint32 &gt; &amp;&#160;</td>
          <td class="paramname"><em>utf32String</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct from an UTF-32 string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">utf32String</td><td>UTF-32 string to assign </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="af862594d3c4070d8ddbf08cf8dce4f59" name="af862594d3c4070d8ddbf08cf8dce4f59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af862594d3c4070d8ddbf08cf8dce4f59">&#9670;&#160;</a></span>String() <span class="overload">[11/11]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>copy</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">copy</td><td>Instance to copy </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8ec30ddc08e3a6bd11c99aed782f6dfe" name="a8ec30ddc08e3a6bd11c99aed782f6dfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ec30ddc08e3a6bd11c99aed782f6dfe">&#9670;&#160;</a></span>begin() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.html#ac90f2b7b28f703020f8d027e98806235">Iterator</a> sf::String::begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return an iterator to the beginning of the string. </p>
<dl class="section return"><dt>Returns</dt><dd>Read-write iterator to the beginning of the string characters</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#ac823012f39cb6f61100418876e99d53b" title="Return an iterator to the end of the string.">end</a> </dd></dl>

</div>
</div>
<a id="a0e4755d6b4d51de7c3dc2e984b79f95d" name="a0e4755d6b4d51de7c3dc2e984b79f95d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e4755d6b4d51de7c3dc2e984b79f95d">&#9670;&#160;</a></span>begin() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.html#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a> sf::String::begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return an iterator to the beginning of the string. </p>
<dl class="section return"><dt>Returns</dt><dd>Read-only iterator to the beginning of the string characters</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#ac823012f39cb6f61100418876e99d53b" title="Return an iterator to the end of the string.">end</a> </dd></dl>

</div>
</div>
<a id="a391c1b4950cbf3d3f8040cea73af2969" name="a391c1b4950cbf3d3f8040cea73af2969"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a391c1b4950cbf3d3f8040cea73af2969">&#9670;&#160;</a></span>clear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sf::String::clear </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clear the string. </p>
<p>This function removes all the characters from the string.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a2ba26cb6945d2bbb210b822f222aa7f6" title="Check whether the string is empty or not.">isEmpty</a>, <a class="el" href="classsf_1_1String.html#aaa78a0a46b3fbe200a4ccdedc326eb93" title="Erase one or more characters from the string.">erase</a> </dd></dl>

</div>
</div>
<a id="ac823012f39cb6f61100418876e99d53b" name="ac823012f39cb6f61100418876e99d53b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac823012f39cb6f61100418876e99d53b">&#9670;&#160;</a></span>end() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.html#ac90f2b7b28f703020f8d027e98806235">Iterator</a> sf::String::end </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return an iterator to the end of the string. </p>
<p>The end iterator refers to 1 position past the last character; thus it represents an invalid character and should never be accessed.</p>
<dl class="section return"><dt>Returns</dt><dd>Read-write iterator to the end of the string characters</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a8ec30ddc08e3a6bd11c99aed782f6dfe" title="Return an iterator to the beginning of the string.">begin</a> </dd></dl>

</div>
</div>
<a id="af1ab4c82ff2bdfb6903b4b1bb78a8e5c" name="af1ab4c82ff2bdfb6903b4b1bb78a8e5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1ab4c82ff2bdfb6903b4b1bb78a8e5c">&#9670;&#160;</a></span>end() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.html#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a> sf::String::end </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return an iterator to the end of the string. </p>
<p>The end iterator refers to 1 position past the last character; thus it represents an invalid character and should never be accessed.</p>
<dl class="section return"><dt>Returns</dt><dd>Read-only iterator to the end of the string characters</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a8ec30ddc08e3a6bd11c99aed782f6dfe" title="Return an iterator to the beginning of the string.">begin</a> </dd></dl>

</div>
</div>
<a id="aaa78a0a46b3fbe200a4ccdedc326eb93" name="aaa78a0a46b3fbe200a4ccdedc326eb93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa78a0a46b3fbe200a4ccdedc326eb93">&#9670;&#160;</a></span>erase()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sf::String::erase </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>count</em> = <code>1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Erase one or more characters from the string. </p>
<p>This function removes a sequence of <em>count</em> characters starting from <em>position</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>Position of the first character to erase </td></tr>
    <tr><td class="paramname">count</td><td>Number of characters to erase </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aa189ec8656854106ab8d2e935fd9cbcc" name="aa189ec8656854106ab8d2e935fd9cbcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa189ec8656854106ab8d2e935fd9cbcc">&#9670;&#160;</a></span>find()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::size_t sf::String::find </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>str</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>start</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find a sequence of one or more characters in the string. </p>
<p>This function searches for the characters of <em>str</em> in the string, starting from <em>start</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">str</td><td>Characters to find </td></tr>
    <tr><td class="paramname">start</td><td>Where to begin searching</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Position of <em>str</em> in the string, or <a class="el" href="classsf_1_1String.html#abaadecaf12a6b41c54d725c75fd28527" title="Represents an invalid position in the string.">String::InvalidPos</a> if not found </dd></dl>

</div>
</div>
<a id="a81f70eecad0000a4f2e4d66f97b80300" name="a81f70eecad0000a4f2e4d66f97b80300"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81f70eecad0000a4f2e4d66f97b80300">&#9670;&#160;</a></span>fromUtf16()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classsf_1_1String.html">String</a> sf::String::fromUtf16 </td>
          <td>(</td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>begin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>end</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create a new <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> from a UTF-16 encoded string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">begin</td><td>Forward iterator to the beginning of the UTF-16 sequence </td></tr>
    <tr><td class="paramname">end</td><td>Forward iterator to the end of the UTF-16 sequence</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> containing the source string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#aa7beb7ae5b26e63dcbbfa390e27a9e4b" title="Create a new sf::String from a UTF-8 encoded string.">fromUtf8</a>, <a class="el" href="classsf_1_1String.html#ab023a4900dce37ee71ab9e29b30a23cb" title="Create a new sf::String from a UTF-32 encoded string.">fromUtf32</a> </dd></dl>

</div>
</div>
<a id="ab023a4900dce37ee71ab9e29b30a23cb" name="ab023a4900dce37ee71ab9e29b30a23cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab023a4900dce37ee71ab9e29b30a23cb">&#9670;&#160;</a></span>fromUtf32()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classsf_1_1String.html">String</a> sf::String::fromUtf32 </td>
          <td>(</td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>begin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>end</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create a new <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> from a UTF-32 encoded string. </p>
<p>This function is provided for consistency, it is equivalent to using the constructors that takes a const sf::Uint32* or a std::basic_string&lt;sf::Uint32&gt;.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">begin</td><td>Forward iterator to the beginning of the UTF-32 sequence </td></tr>
    <tr><td class="paramname">end</td><td>Forward iterator to the end of the UTF-32 sequence</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> containing the source string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#aa7beb7ae5b26e63dcbbfa390e27a9e4b" title="Create a new sf::String from a UTF-8 encoded string.">fromUtf8</a>, <a class="el" href="classsf_1_1String.html#a81f70eecad0000a4f2e4d66f97b80300" title="Create a new sf::String from a UTF-16 encoded string.">fromUtf16</a> </dd></dl>

</div>
</div>
<a id="aa7beb7ae5b26e63dcbbfa390e27a9e4b" name="aa7beb7ae5b26e63dcbbfa390e27a9e4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7beb7ae5b26e63dcbbfa390e27a9e4b">&#9670;&#160;</a></span>fromUtf8()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classsf_1_1String.html">String</a> sf::String::fromUtf8 </td>
          <td>(</td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>begin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>end</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create a new <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> from a UTF-8 encoded string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">begin</td><td>Forward iterator to the beginning of the UTF-8 sequence </td></tr>
    <tr><td class="paramname">end</td><td>Forward iterator to the end of the UTF-8 sequence</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> containing the source string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a81f70eecad0000a4f2e4d66f97b80300" title="Create a new sf::String from a UTF-16 encoded string.">fromUtf16</a>, <a class="el" href="classsf_1_1String.html#ab023a4900dce37ee71ab9e29b30a23cb" title="Create a new sf::String from a UTF-32 encoded string.">fromUtf32</a> </dd></dl>

</div>
</div>
<a id="a3ed7f3ad41659a2b31a8d8e99a7b8199" name="a3ed7f3ad41659a2b31a8d8e99a7b8199"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ed7f3ad41659a2b31a8d8e99a7b8199">&#9670;&#160;</a></span>getData()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const Uint32 * sf::String::getData </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get a pointer to the C-style array of characters. </p>
<p>This functions provides a read-only access to a null-terminated C-style representation of the string. The returned pointer is temporary and is meant only for immediate use, thus it is not recommended to store it.</p>
<dl class="section return"><dt>Returns</dt><dd>Read-only pointer to the array of characters </dd></dl>

</div>
</div>
<a id="ae7aff54e178f5d3e399953adff5cad20" name="ae7aff54e178f5d3e399953adff5cad20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7aff54e178f5d3e399953adff5cad20">&#9670;&#160;</a></span>getSize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::size_t sf::String::getSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the size of the string. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of characters in the string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a2ba26cb6945d2bbb210b822f222aa7f6" title="Check whether the string is empty or not.">isEmpty</a> </dd></dl>

</div>
</div>
<a id="ad0b1455deabf07af13ee79812e05fa02" name="ad0b1455deabf07af13ee79812e05fa02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0b1455deabf07af13ee79812e05fa02">&#9670;&#160;</a></span>insert()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sf::String::insert </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>str</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Insert one or more characters into the string. </p>
<p>This function inserts the characters of <em>str</em> into the string, starting from <em>position</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>Position of insertion </td></tr>
    <tr><td class="paramname">str</td><td>Characters to insert </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a2ba26cb6945d2bbb210b822f222aa7f6" name="a2ba26cb6945d2bbb210b822f222aa7f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ba26cb6945d2bbb210b822f222aa7f6">&#9670;&#160;</a></span>isEmpty()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool sf::String::isEmpty </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check whether the string is empty or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the string is empty (i.e. contains no character)</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a391c1b4950cbf3d3f8040cea73af2969" title="Clear the string.">clear</a>, <a class="el" href="classsf_1_1String.html#ae7aff54e178f5d3e399953adff5cad20" title="Get the size of the string.">getSize</a> </dd></dl>

</div>
</div>
<a id="a884816a0f688cfd48f9324c9741dc257" name="a884816a0f688cfd48f9324c9741dc257"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a884816a0f688cfd48f9324c9741dc257">&#9670;&#160;</a></span>operator std::string()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::operator std::string </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implicit conversion operator to std::string (ANSI string) </p>
<p>The current global locale is used for conversion. If you want to explicitly specify a locale, see toAnsiString. Characters that do not fit in the target encoding are discarded from the returned string. This operator is defined for convenience, and is equivalent to calling <a class="el" href="classsf_1_1String.html#ada5d5bba4528aceb0a1e298553e6c30a" title="Convert the Unicode string to an ANSI string.">toAnsiString()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>Converted ANSI string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#ada5d5bba4528aceb0a1e298553e6c30a" title="Convert the Unicode string to an ANSI string.">toAnsiString</a>, operator std::wstring </dd></dl>

</div>
</div>
<a id="a6bd1444bebaca9bbf01ba203061f5076" name="a6bd1444bebaca9bbf01ba203061f5076"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bd1444bebaca9bbf01ba203061f5076">&#9670;&#160;</a></span>operator std::wstring()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::operator std::wstring </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implicit conversion operator to std::wstring (wide string) </p>
<p>Characters that do not fit in the target encoding are discarded from the returned string. This operator is defined for convenience, and is equivalent to calling <a class="el" href="classsf_1_1String.html#a9d81aa3103e7e2062bd85d912a5aecf1" title="Convert the Unicode string to a wide string.">toWideString()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>Converted wide string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a9d81aa3103e7e2062bd85d912a5aecf1" title="Convert the Unicode string to a wide string.">toWideString</a>, operator std::string </dd></dl>

</div>
</div>
<a id="afdae61e813b2951a6e39015e34a143f7" name="afdae61e813b2951a6e39015e34a143f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdae61e813b2951a6e39015e34a143f7">&#9670;&#160;</a></span>operator+=()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.html">String</a> &amp; sf::String::operator+= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>right</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Overload of += operator to append an UTF-32 string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">right</td><td><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">String</a> to append</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to self </dd></dl>

</div>
</div>
<a id="af14c8e1bf351cf18486f0258c36260d7" name="af14c8e1bf351cf18486f0258c36260d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af14c8e1bf351cf18486f0258c36260d7">&#9670;&#160;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.html">String</a> &amp; sf::String::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>right</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Overload of assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">right</td><td>Instance to assign</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to self </dd></dl>

</div>
</div>
<a id="a3e2041bd9ae84d223e6b12e46e5aa5d6" name="a3e2041bd9ae84d223e6b12e46e5aa5d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e2041bd9ae84d223e6b12e46e5aa5d6">&#9670;&#160;</a></span>operator[]() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint32 &amp; sf::String::operator[] </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>index</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Overload of [] operator to access a character by its position. </p>
<p>This function provides read and write access to characters. Note: the behavior is undefined if <em>index</em> is out of range.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">index</td><td>Index of the character to get</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to the character at position <em>index</em> </dd></dl>

</div>
</div>
<a id="a035c1b585a0ebed81e773ecafed57926" name="a035c1b585a0ebed81e773ecafed57926"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a035c1b585a0ebed81e773ecafed57926">&#9670;&#160;</a></span>operator[]() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint32 sf::String::operator[] </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>index</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Overload of [] operator to access a character by its position. </p>
<p>This function provides read-only access to characters. Note: the behavior is undefined if <em>index</em> is out of range.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">index</td><td>Index of the character to get</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Character at position <em>index</em> </dd></dl>

</div>
</div>
<a id="a82bbfee2bf23c641e5361ad505c07921" name="a82bbfee2bf23c641e5361ad505c07921"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82bbfee2bf23c641e5361ad505c07921">&#9670;&#160;</a></span>replace() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sf::String::replace </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>searchFor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>replaceWith</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Replace all occurrences of a substring with a replacement string. </p>
<p>This function replaces all occurrences of <em>searchFor</em> in this string with the string <em>replaceWith</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">searchFor</td><td>The value being searched for </td></tr>
    <tr><td class="paramname">replaceWith</td><td>The value that replaces found <em>searchFor</em> values </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ad460e628c287b0fa88deba2eb0b6744b" name="ad460e628c287b0fa88deba2eb0b6744b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad460e628c287b0fa88deba2eb0b6744b">&#9670;&#160;</a></span>replace() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sf::String::replace </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>replaceWith</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Replace a substring with another string. </p>
<p>This function replaces the substring that starts at index <em>position</em> and spans <em>length</em> characters with the string <em>replaceWith</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>Index of the first character to be replaced </td></tr>
    <tr><td class="paramname">length</td><td>Number of characters to replace. You can pass InvalidPos to replace all characters until the end of the string. </td></tr>
    <tr><td class="paramname">replaceWith</td><td><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">String</a> that replaces the given substring. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a492645e00032455e6d92ff0e992654ce" name="a492645e00032455e6d92ff0e992654ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a492645e00032455e6d92ff0e992654ce">&#9670;&#160;</a></span>substring()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.html">String</a> sf::String::substring </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>length</em> = <code><a class="el" href="classsf_1_1String.html#abaadecaf12a6b41c54d725c75fd28527">InvalidPos</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return a part of the string. </p>
<p>This function returns the substring that starts at index <em>position</em> and spans <em>length</em> characters.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>Index of the first character </td></tr>
    <tr><td class="paramname">length</td><td>Number of characters to include in the substring (if the string is shorter, as many characters as possible are included). <a class="el" href="classsf_1_1String.html#abaadecaf12a6b41c54d725c75fd28527">InvalidPos</a> can be used to include all characters until the end of the string.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">String</a> object containing a substring of this object </dd></dl>

</div>
</div>
<a id="ada5d5bba4528aceb0a1e298553e6c30a" name="ada5d5bba4528aceb0a1e298553e6c30a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada5d5bba4528aceb0a1e298553e6c30a">&#9670;&#160;</a></span>toAnsiString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string sf::String::toAnsiString </td>
          <td>(</td>
          <td class="paramtype">const std::locale &amp;&#160;</td>
          <td class="paramname"><em>locale</em> = <code>std::locale()</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert the Unicode string to an ANSI string. </p>
<p>The UTF-32 string is converted to an ANSI string in the encoding defined by <em>locale</em>. Characters that do not fit in the target encoding are discarded from the returned string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">locale</td><td>Locale to use for conversion</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted ANSI string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a9d81aa3103e7e2062bd85d912a5aecf1" title="Convert the Unicode string to a wide string.">toWideString</a>, operator std::string </dd></dl>

</div>
</div>
<a id="ab805f230a0b2e972f9f32ac4cf11d912" name="ab805f230a0b2e972f9f32ac4cf11d912"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab805f230a0b2e972f9f32ac4cf11d912">&#9670;&#160;</a></span>toUtf16()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::basic_string&lt; Uint16 &gt; sf::String::toUtf16 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert the Unicode string to a UTF-16 string. </p>
<dl class="section return"><dt>Returns</dt><dd>Converted UTF-16 string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a2a4f366d5db833ae818881507b46e13a" title="Convert the Unicode string to a UTF-8 string.">toUtf8</a>, <a class="el" href="classsf_1_1String.html#aef4f51ebe43465c665c78692d0262e43" title="Convert the Unicode string to a UTF-32 string.">toUtf32</a> </dd></dl>

</div>
</div>
<a id="aef4f51ebe43465c665c78692d0262e43" name="aef4f51ebe43465c665c78692d0262e43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef4f51ebe43465c665c78692d0262e43">&#9670;&#160;</a></span>toUtf32()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::basic_string&lt; Uint32 &gt; sf::String::toUtf32 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert the Unicode string to a UTF-32 string. </p>
<p>This function doesn't perform any conversion, since the string is already stored as UTF-32 internally.</p>
<dl class="section return"><dt>Returns</dt><dd>Converted UTF-32 string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#a2a4f366d5db833ae818881507b46e13a" title="Convert the Unicode string to a UTF-8 string.">toUtf8</a>, <a class="el" href="classsf_1_1String.html#ab805f230a0b2e972f9f32ac4cf11d912" title="Convert the Unicode string to a UTF-16 string.">toUtf16</a> </dd></dl>

</div>
</div>
<a id="a2a4f366d5db833ae818881507b46e13a" name="a2a4f366d5db833ae818881507b46e13a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a4f366d5db833ae818881507b46e13a">&#9670;&#160;</a></span>toUtf8()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::basic_string&lt; Uint8 &gt; sf::String::toUtf8 </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert the Unicode string to a UTF-8 string. </p>
<dl class="section return"><dt>Returns</dt><dd>Converted UTF-8 string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#ab805f230a0b2e972f9f32ac4cf11d912" title="Convert the Unicode string to a UTF-16 string.">toUtf16</a>, <a class="el" href="classsf_1_1String.html#aef4f51ebe43465c665c78692d0262e43" title="Convert the Unicode string to a UTF-32 string.">toUtf32</a> </dd></dl>

</div>
</div>
<a id="a9d81aa3103e7e2062bd85d912a5aecf1" name="a9d81aa3103e7e2062bd85d912a5aecf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d81aa3103e7e2062bd85d912a5aecf1">&#9670;&#160;</a></span>toWideString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::wstring sf::String::toWideString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert the Unicode string to a wide string. </p>
<p>Characters that do not fit in the target encoding are discarded from the returned string.</p>
<dl class="section return"><dt>Returns</dt><dd>Converted wide string</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1String.html#ada5d5bba4528aceb0a1e298553e6c30a" title="Convert the Unicode string to an ANSI string.">toAnsiString</a>, operator std::wstring </dd></dl>

</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a3bfb9217788a9978499b8d5696bb0ef2" name="a3bfb9217788a9978499b8d5696bb0ef2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bfb9217788a9978499b8d5696bb0ef2">&#9670;&#160;</a></span>operator!=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>right</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Overload of != operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if both strings are different </dd></dl>

</div>
</div>
<a id="af140f992b7698cf1448677c2c8e11bf1" name="af140f992b7698cf1448677c2c8e11bf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af140f992b7698cf1448677c2c8e11bf1">&#9670;&#160;</a></span>operator+()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.html">String</a> operator+ </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>right</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Overload of binary + operator to concatenate two strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Concatenated string </dd></dl>

</div>
</div>
<a id="a5158a142e0966685ec7fb4e147b24ef0" name="a5158a142e0966685ec7fb4e147b24ef0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5158a142e0966685ec7fb4e147b24ef0">&#9670;&#160;</a></span>operator&lt;()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator&lt; </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>right</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Overload of &lt; operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <em>left</em> is lexicographically before <em>right</em> </dd></dl>

</div>
</div>
<a id="ac1c1bb5dcf02aad3b2c0a1bf74a11cc9" name="ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1c1bb5dcf02aad3b2c0a1bf74a11cc9">&#9670;&#160;</a></span>operator&lt;=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator&lt;= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>right</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Overload of &lt;= operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <em>left</em> is lexicographically before or equivalent to <em>right</em> </dd></dl>

</div>
</div>
<a id="a483931724196c580552b68751fb4d837" name="a483931724196c580552b68751fb4d837"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a483931724196c580552b68751fb4d837">&#9670;&#160;</a></span>operator==()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>right</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Overload of == operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if both strings are equal </dd></dl>

</div>
</div>
<a id="ac96278a8cbe282632b11f0c8c007df0c" name="ac96278a8cbe282632b11f0c8c007df0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac96278a8cbe282632b11f0c8c007df0c">&#9670;&#160;</a></span>operator&gt;()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator&gt; </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>right</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Overload of &gt; operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <em>left</em> is lexicographically after <em>right</em> </dd></dl>

</div>
</div>
<a id="a112689eec28e0ca9489e8c4ec6a34493" name="a112689eec28e0ca9489e8c4ec6a34493"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a112689eec28e0ca9489e8c4ec6a34493">&#9670;&#160;</a></span>operator&gt;=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator&gt;= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>right</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Overload of &gt;= operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <em>left</em> is lexicographically after or equivalent to <em>right</em> </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abaadecaf12a6b41c54d725c75fd28527" name="abaadecaf12a6b41c54d725c75fd28527"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaadecaf12a6b41c54d725c75fd28527">&#9670;&#160;</a></span>InvalidPos</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::size_t sf::String::InvalidPos</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Represents an invalid position in the string. </p>

<p class="definition">Definition at line <a class="el" href="String_8hpp_source.html#l00058">58</a> of file <a class="el" href="String_8hpp_source.html">String.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="String_8hpp_source.html">String.hpp</a></li>
</ul>
</div><!-- contents -->
        </div>
        <div id="footer-container">
            <div id="footer">
                SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br>
                Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
                Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
            </div>
        </div>
    </body>
</html>
